home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / lib / python2.5 / cookielib.pyc (.txt) < prev    next >
Python Compiled Bytecode  |  2008-10-29  |  55KB  |  1,809 lines

  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.5)
  3.  
  4. """HTTP cookie handling for web clients.
  5.  
  6. This module has (now fairly distant) origins in Gisle Aas' Perl module
  7. HTTP::Cookies, from the libwww-perl library.
  8.  
  9. Docstrings, comments and debug strings in this code refer to the
  10. attributes of the HTTP cookie system as cookie-attributes, to distinguish
  11. them clearly from Python attributes.
  12.  
  13. Class diagram (note that BSDDBCookieJar and the MSIE* classes are not
  14. distributed with the Python standard library, but are available from
  15. http://wwwsearch.sf.net/):
  16.  
  17.                         CookieJar____
  18.                         /     \\                  FileCookieJar      \\                   /    |   \\         \\       MozillaCookieJar | LWPCookieJar \\                        |               |                        |   ---MSIEBase |                         |  /      |     |                          | /   MSIEDBCookieJar BSDDBCookieJar
  19.                   |/
  20.                MSIECookieJar
  21.  
  22. """
  23. __all__ = [
  24.     'Cookie',
  25.     'CookieJar',
  26.     'CookiePolicy',
  27.     'DefaultCookiePolicy',
  28.     'FileCookieJar',
  29.     'LWPCookieJar',
  30.     'LoadError',
  31.     'MozillaCookieJar']
  32. import re
  33. import urlparse
  34. import copy
  35. import time
  36. import urllib
  37.  
  38. try:
  39.     import threading as _threading
  40. except ImportError:
  41.     import dummy_threading as _threading
  42.  
  43. import httplib
  44. from calendar import timegm
  45. debug = False
  46. logger = None
  47.  
  48. def _debug(*args):
  49.     global logger
  50.     if not debug:
  51.         return None
  52.     
  53.     if not logger:
  54.         import logging as logging
  55.         logger = logging.getLogger('cookielib')
  56.     
  57.     return logger.debug(*args)
  58.  
  59. DEFAULT_HTTP_PORT = str(httplib.HTTP_PORT)
  60. MISSING_FILENAME_TEXT = 'a filename was not supplied (nor was the CookieJar instance initialised with one)'
  61.  
  62. def _warn_unhandled_exception():
  63.     import warnings as warnings
  64.     import traceback as traceback
  65.     import StringIO as StringIO
  66.     f = StringIO.StringIO()
  67.     traceback.print_exc(None, f)
  68.     msg = f.getvalue()
  69.     warnings.warn('cookielib bug!\n%s' % msg, stacklevel = 2)
  70.  
  71. EPOCH_YEAR = 1970
  72.  
  73. def _timegm(tt):
  74.     (year, month, mday, hour, min, sec) = tt[:6]
  75.     if year >= EPOCH_YEAR:
  76.         pass
  77.  
  78. DAYS = [
  79.     'Mon',
  80.     'Tue',
  81.     'Wed',
  82.     'Thu',
  83.     'Fri',
  84.     'Sat',
  85.     'Sun']
  86. MONTHS = [
  87.     'Jan',
  88.     'Feb',
  89.     'Mar',
  90.     'Apr',
  91.     'May',
  92.     'Jun',
  93.     'Jul',
  94.     'Aug',
  95.     'Sep',
  96.     'Oct',
  97.     'Nov',
  98.     'Dec']
  99. MONTHS_LOWER = []
  100. for month in MONTHS:
  101.     MONTHS_LOWER.append(month.lower())
  102.  
  103.  
  104. def time2isoz(t = None):
  105.     '''Return a string representing time in seconds since epoch, t.
  106.  
  107.     If the function is called without an argument, it will use the current
  108.     time.
  109.  
  110.     The format of the returned string is like "YYYY-MM-DD hh:mm:ssZ",
  111.     representing Universal Time (UTC, aka GMT).  An example of this format is:
  112.  
  113.     1994-11-24 08:49:37Z
  114.  
  115.     '''
  116.     if t is None:
  117.         t = time.time()
  118.     
  119.     (year, mon, mday, hour, min, sec) = time.gmtime(t)[:6]
  120.     return '%04d-%02d-%02d %02d:%02d:%02dZ' % (year, mon, mday, hour, min, sec)
  121.  
  122.  
  123. def time2netscape(t = None):
  124.     '''Return a string representing time in seconds since epoch, t.
  125.  
  126.     If the function is called without an argument, it will use the current
  127.     time.
  128.  
  129.     The format of the returned string is like this:
  130.  
  131.     Wed, DD-Mon-YYYY HH:MM:SS GMT
  132.  
  133.     '''
  134.     if t is None:
  135.         t = time.time()
  136.     
  137.     (year, mon, mday, hour, min, sec, wday) = time.gmtime(t)[:7]
  138.     return '%s %02d-%s-%04d %02d:%02d:%02d GMT' % (DAYS[wday], mday, MONTHS[mon - 1], year, hour, min, sec)
  139.  
  140. UTC_ZONES = {
  141.     'GMT': None,
  142.     'UTC': None,
  143.     'UT': None,
  144.     'Z': None }
  145. TIMEZONE_RE = re.compile('^([-+])?(\\d\\d?):?(\\d\\d)?$')
  146.  
  147. def offset_from_tz_string(tz):
  148.     offset = None
  149.     if tz in UTC_ZONES:
  150.         offset = 0
  151.     else:
  152.         m = TIMEZONE_RE.search(tz)
  153.         if m:
  154.             offset = 3600 * int(m.group(2))
  155.             if m.group(3):
  156.                 offset = offset + 60 * int(m.group(3))
  157.             
  158.             if m.group(1) == '-':
  159.                 offset = -offset
  160.             
  161.         
  162.     return offset
  163.  
  164.  
  165. def _str2time(day, mon, yr, hr, min, sec, tz):
  166.     
  167.     try:
  168.         mon = MONTHS_LOWER.index(mon.lower()) + 1
  169.     except ValueError:
  170.         
  171.         try:
  172.             imon = int(mon)
  173.         except ValueError:
  174.             return None
  175.  
  176.         if imon <= imon:
  177.             pass
  178.         elif imon <= 12:
  179.             mon = imon
  180.         else:
  181.             return None
  182.     except:
  183.         1
  184.  
  185.     if hr is None:
  186.         hr = 0
  187.     
  188.     if min is None:
  189.         min = 0
  190.     
  191.     if sec is None:
  192.         sec = 0
  193.     
  194.     yr = int(yr)
  195.     day = int(day)
  196.     hr = int(hr)
  197.     min = int(min)
  198.     sec = int(sec)
  199.     if yr < 1000:
  200.         cur_yr = time.localtime(time.time())[0]
  201.         m = cur_yr % 100
  202.         tmp = yr
  203.         yr = yr + cur_yr - m
  204.         m = m - tmp
  205.         if abs(m) > 50:
  206.             if m > 0:
  207.                 yr = yr + 100
  208.             else:
  209.                 yr = yr - 100
  210.         
  211.     
  212.     t = _timegm((yr, mon, day, hr, min, sec, tz))
  213.     if t is not None:
  214.         if tz is None:
  215.             tz = 'UTC'
  216.         
  217.         tz = tz.upper()
  218.         offset = offset_from_tz_string(tz)
  219.         if offset is None:
  220.             return None
  221.         
  222.         t = t - offset
  223.     
  224.     return t
  225.  
  226. STRICT_DATE_RE = re.compile('^[SMTWF][a-z][a-z], (\\d\\d) ([JFMASOND][a-z][a-z]) (\\d\\d\\d\\d) (\\d\\d):(\\d\\d):(\\d\\d) GMT$')
  227. WEEKDAY_RE = re.compile('^(?:Sun|Mon|Tue|Wed|Thu|Fri|Sat)[a-z]*,?\\s*', re.I)
  228. LOOSE_HTTP_DATE_RE = re.compile('^\n    (\\d\\d?)            # day\n       (?:\\s+|[-\\/])\n    (\\w+)              # month\n        (?:\\s+|[-\\/])\n    (\\d+)              # year\n    (?:\n          (?:\\s+|:)    # separator before clock\n       (\\d\\d?):(\\d\\d)  # hour:min\n       (?::(\\d\\d))?    # optional seconds\n    )?                 # optional clock\n       \\s*\n    ([-+]?\\d{2,4}|(?![APap][Mm]\\b)[A-Za-z]+)? # timezone\n       \\s*\n    (?:\\(\\w+\\))?       # ASCII representation of timezone in parens.\n       \\s*$', re.X)
  229.  
  230. def http2time(text):
  231.     '''Returns time in seconds since epoch of time represented by a string.
  232.  
  233.     Return value is an integer.
  234.  
  235.     None is returned if the format of str is unrecognized, the time is outside
  236.     the representable range, or the timezone string is not recognized.  If the
  237.     string contains no timezone, UTC is assumed.
  238.  
  239.     The timezone in the string may be numerical (like "-0800" or "+0100") or a
  240.     string timezone (like "UTC", "GMT", "BST" or "EST").  Currently, only the
  241.     timezone strings equivalent to UTC (zero offset) are known to the function.
  242.  
  243.     The function loosely parses the following formats:
  244.  
  245.     Wed, 09 Feb 1994 22:23:32 GMT       -- HTTP format
  246.     Tuesday, 08-Feb-94 14:15:29 GMT     -- old rfc850 HTTP format
  247.     Tuesday, 08-Feb-1994 14:15:29 GMT   -- broken rfc850 HTTP format
  248.     09 Feb 1994 22:23:32 GMT            -- HTTP format (no weekday)
  249.     08-Feb-94 14:15:29 GMT              -- rfc850 format (no weekday)
  250.     08-Feb-1994 14:15:29 GMT            -- broken rfc850 format (no weekday)
  251.  
  252.     The parser ignores leading and trailing whitespace.  The time may be
  253.     absent.
  254.  
  255.     If the year is given with only 2 digits, the function will select the
  256.     century that makes the year closest to the current date.
  257.  
  258.     '''
  259.     m = STRICT_DATE_RE.search(text)
  260.     if m:
  261.         g = m.groups()
  262.         mon = MONTHS_LOWER.index(g[1].lower()) + 1
  263.         tt = (int(g[2]), mon, int(g[0]), int(g[3]), int(g[4]), float(g[5]))
  264.         return _timegm(tt)
  265.     
  266.     text = text.lstrip()
  267.     text = WEEKDAY_RE.sub('', text, 1)
  268.     (day, mon, yr, hr, min, sec, tz) = [
  269.         None] * 7
  270.     m = LOOSE_HTTP_DATE_RE.search(text)
  271.     if m is not None:
  272.         (day, mon, yr, hr, min, sec, tz) = m.groups()
  273.     else:
  274.         return None
  275.     return _str2time(day, mon, yr, hr, min, sec, tz)
  276.  
  277. ISO_DATE_RE = re.compile('^\n    (\\d{4})              # year\n       [-\\/]?\n    (\\d\\d?)              # numerical month\n       [-\\/]?\n    (\\d\\d?)              # day\n   (?:\n         (?:\\s+|[-:Tt])  # separator before clock\n      (\\d\\d?):?(\\d\\d)    # hour:min\n      (?::?(\\d\\d(?:\\.\\d*)?))?  # optional seconds (and fractional)\n   )?                    # optional clock\n      \\s*\n   ([-+]?\\d\\d?:?(:?\\d\\d)?\n    |Z|z)?               # timezone  (Z is "zero meridian", i.e. GMT)\n      \\s*$', re.X)
  278.  
  279. def iso2time(text):
  280.     '''
  281.     As for http2time, but parses the ISO 8601 formats:
  282.  
  283.     1994-02-03 14:15:29 -0100    -- ISO 8601 format
  284.     1994-02-03 14:15:29          -- zone is optional
  285.     1994-02-03                   -- only date
  286.     1994-02-03T14:15:29          -- Use T as separator
  287.     19940203T141529Z             -- ISO 8601 compact format
  288.     19940203                     -- only date
  289.  
  290.     '''
  291.     text = text.lstrip()
  292.     (day, mon, yr, hr, min, sec, tz) = [
  293.         None] * 7
  294.     m = ISO_DATE_RE.search(text)
  295.     if m is not None:
  296.         (yr, mon, day, hr, min, sec, tz, _) = m.groups()
  297.     else:
  298.         return None
  299.     return _str2time(day, mon, yr, hr, min, sec, tz)
  300.  
  301.  
  302. def unmatched(match):
  303.     '''Return unmatched part of re.Match object.'''
  304.     (start, end) = match.span(0)
  305.     return match.string[:start] + match.string[end:]
  306.  
  307. HEADER_TOKEN_RE = re.compile('^\\s*([^=\\s;,]+)')
  308. HEADER_QUOTED_VALUE_RE = re.compile('^\\s*=\\s*\\"([^\\"\\\\]*(?:\\\\.[^\\"\\\\]*)*)\\"')
  309. HEADER_VALUE_RE = re.compile('^\\s*=\\s*([^\\s;,]*)')
  310. HEADER_ESCAPE_RE = re.compile('\\\\(.)')
  311.  
  312. def split_header_words(header_values):
  313.     '''Parse header values into a list of lists containing key,value pairs.
  314.  
  315.     The function knows how to deal with ",", ";" and "=" as well as quoted
  316.     values after "=".  A list of space separated tokens are parsed as if they
  317.     were separated by ";".
  318.  
  319.     If the header_values passed as argument contains multiple values, then they
  320.     are treated as if they were a single value separated by comma ",".
  321.  
  322.     This means that this function is useful for parsing header fields that
  323.     follow this syntax (BNF as from the HTTP/1.1 specification, but we relax
  324.     the requirement for tokens).
  325.  
  326.       headers           = #header
  327.       header            = (token | parameter) *( [";"] (token | parameter))
  328.  
  329.       token             = 1*<any CHAR except CTLs or separators>
  330.       separators        = "(" | ")" | "<" | ">" | "@"
  331.                         | "," | ";" | ":" | "\\" | <">
  332.                         | "/" | "[" | "]" | "?" | "="
  333.                         | "{" | "}" | SP | HT
  334.  
  335.       quoted-string     = ( <"> *(qdtext | quoted-pair ) <"> )
  336.       qdtext            = <any TEXT except <">>
  337.       quoted-pair       = "\\" CHAR
  338.  
  339.       parameter         = attribute "=" value
  340.       attribute         = token
  341.       value             = token | quoted-string
  342.  
  343.     Each header is represented by a list of key/value pairs.  The value for a
  344.     simple token (not part of a parameter) is None.  Syntactically incorrect
  345.     headers will not necessarily be parsed as you would want.
  346.  
  347.     This is easier to describe with some examples:
  348.  
  349.     >>> split_header_words([\'foo="bar"; port="80,81"; discard, bar=baz\'])
  350.     [[(\'foo\', \'bar\'), (\'port\', \'80,81\'), (\'discard\', None)], [(\'bar\', \'baz\')]]
  351.     >>> split_header_words([\'text/html; charset="iso-8859-1"\'])
  352.     [[(\'text/html\', None), (\'charset\', \'iso-8859-1\')]]
  353.     >>> split_header_words([r\'Basic realm="\\"foo\\bar\\""\'])
  354.     [[(\'Basic\', None), (\'realm\', \'"foobar"\')]]
  355.  
  356.     '''
  357.     if not not isinstance(header_values, basestring):
  358.         raise AssertionError
  359.     result = []
  360.     for text in header_values:
  361.         orig_text = text
  362.         pairs = []
  363.         while text:
  364.             m = HEADER_TOKEN_RE.search(text)
  365.             if m:
  366.                 text = unmatched(m)
  367.                 name = m.group(1)
  368.                 m = HEADER_QUOTED_VALUE_RE.search(text)
  369.                 if m:
  370.                     text = unmatched(m)
  371.                     value = m.group(1)
  372.                     value = HEADER_ESCAPE_RE.sub('\\1', value)
  373.                 else:
  374.                     m = HEADER_VALUE_RE.search(text)
  375.                     if m:
  376.                         text = unmatched(m)
  377.                         value = m.group(1)
  378.                         value = value.rstrip()
  379.                     else:
  380.                         value = None
  381.                 pairs.append((name, value))
  382.                 continue
  383.             if text.lstrip().startswith(','):
  384.                 text = text.lstrip()[1:]
  385.                 if pairs:
  386.                     result.append(pairs)
  387.                 
  388.                 pairs = []
  389.                 continue
  390.             (non_junk, nr_junk_chars) = re.subn('^[=\\s;]*', '', text)
  391.             if not nr_junk_chars > 0:
  392.                 raise AssertionError, "split_header_words bug: '%s', '%s', %s" % (orig_text, text, pairs)
  393.             text = non_junk
  394.         if pairs:
  395.             result.append(pairs)
  396.             continue
  397.     
  398.     return result
  399.  
  400. HEADER_JOIN_ESCAPE_RE = re.compile('([\\"\\\\])')
  401.  
  402. def join_header_words(lists):
  403.     '''Do the inverse (almost) of the conversion done by split_header_words.
  404.  
  405.     Takes a list of lists of (key, value) pairs and produces a single header
  406.     value.  Attribute values are quoted if needed.
  407.  
  408.     >>> join_header_words([[("text/plain", None), ("charset", "iso-8859/1")]])
  409.     \'text/plain; charset="iso-8859/1"\'
  410.     >>> join_header_words([[("text/plain", None)], [("charset", "iso-8859/1")]])
  411.     \'text/plain, charset="iso-8859/1"\'
  412.  
  413.     '''
  414.     headers = []
  415.     for pairs in lists:
  416.         attr = []
  417.         for k, v in pairs:
  418.             if v is not None:
  419.                 if not re.search('^\\w+$', v):
  420.                     v = HEADER_JOIN_ESCAPE_RE.sub('\\\\\\1', v)
  421.                     v = '"%s"' % v
  422.                 
  423.                 k = '%s=%s' % (k, v)
  424.             
  425.             attr.append(k)
  426.         
  427.         if attr:
  428.             headers.append('; '.join(attr))
  429.             continue
  430.     
  431.     return ', '.join(headers)
  432.  
  433.  
  434. def parse_ns_headers(ns_headers):
  435.     '''Ad-hoc parser for Netscape protocol cookie-attributes.
  436.  
  437.     The old Netscape cookie format for Set-Cookie can for instance contain
  438.     an unquoted "," in the expires field, so we have to use this ad-hoc
  439.     parser instead of split_header_words.
  440.  
  441.     XXX This may not make the best possible effort to parse all the crap
  442.     that Netscape Cookie headers contain.  Ronald Tschalar\'s HTTPClient
  443.     parser is probably better, so could do worse than following that if
  444.     this ever gives any trouble.
  445.  
  446.     Currently, this is also used for parsing RFC 2109 cookies.
  447.  
  448.     '''
  449.     known_attrs = ('expires', 'domain', 'path', 'secure', 'port', 'max-age')
  450.     result = []
  451.     for ns_header in ns_headers:
  452.         pairs = []
  453.         version_set = False
  454.         for ii, param in enumerate(re.split(';\\s*', ns_header)):
  455.             param = param.rstrip()
  456.             if param == '':
  457.                 continue
  458.             
  459.             if '=' not in param:
  460.                 k = param
  461.                 v = None
  462.             else:
  463.                 (k, v) = re.split('\\s*=\\s*', param, 1)
  464.                 k = k.lstrip()
  465.             if ii != 0:
  466.                 lc = k.lower()
  467.                 if lc in known_attrs:
  468.                     k = lc
  469.                 
  470.                 if k == 'version':
  471.                     version_set = True
  472.                 
  473.                 if k == 'expires':
  474.                     if v.startswith('"'):
  475.                         v = v[1:]
  476.                     
  477.                     if v.endswith('"'):
  478.                         v = v[:-1]
  479.                     
  480.                     v = http2time(v)
  481.                 
  482.             
  483.             pairs.append((k, v))
  484.         
  485.         if pairs:
  486.             if not version_set:
  487.                 pairs.append(('version', '0'))
  488.             
  489.             result.append(pairs)
  490.             continue
  491.     
  492.     return result
  493.  
  494. IPV4_RE = re.compile('\\.\\d+$')
  495.  
  496. def is_HDN(text):
  497.     '''Return True if text is a host domain name.'''
  498.     if IPV4_RE.search(text):
  499.         return False
  500.     
  501.     if text == '':
  502.         return False
  503.     
  504.     if text[0] == '.' or text[-1] == '.':
  505.         return False
  506.     
  507.     return True
  508.  
  509.  
  510. def domain_match(A, B):
  511.     """Return True if domain A domain-matches domain B, according to RFC 2965.
  512.  
  513.     A and B may be host domain names or IP addresses.
  514.  
  515.     RFC 2965, section 1:
  516.  
  517.     Host names can be specified either as an IP address or a HDN string.
  518.     Sometimes we compare one host name with another.  (Such comparisons SHALL
  519.     be case-insensitive.)  Host A's name domain-matches host B's if
  520.  
  521.          *  their host name strings string-compare equal; or
  522.  
  523.          * A is a HDN string and has the form NB, where N is a non-empty
  524.             name string, B has the form .B', and B' is a HDN string.  (So,
  525.             x.y.com domain-matches .Y.com but not Y.com.)
  526.  
  527.     Note that domain-match is not a commutative operation: a.b.c.com
  528.     domain-matches .c.com, but not the reverse.
  529.  
  530.     """
  531.     A = A.lower()
  532.     B = B.lower()
  533.     if A == B:
  534.         return True
  535.     
  536.     if not is_HDN(A):
  537.         return False
  538.     
  539.     i = A.rfind(B)
  540.     if i == -1 or i == 0:
  541.         return False
  542.     
  543.     if not B.startswith('.'):
  544.         return False
  545.     
  546.     if not is_HDN(B[1:]):
  547.         return False
  548.     
  549.     return True
  550.  
  551.  
  552. def liberal_is_HDN(text):
  553.     '''Return True if text is a sort-of-like a host domain name.
  554.  
  555.     For accepting/blocking domains.
  556.  
  557.     '''
  558.     if IPV4_RE.search(text):
  559.         return False
  560.     
  561.     return True
  562.  
  563.  
  564. def user_domain_match(A, B):
  565.     '''For blocking/accepting domains.
  566.  
  567.     A and B may be host domain names or IP addresses.
  568.  
  569.     '''
  570.     A = A.lower()
  571.     B = B.lower()
  572.     if not liberal_is_HDN(A) and liberal_is_HDN(B):
  573.         if A == B:
  574.             return True
  575.         
  576.         return False
  577.     
  578.     initial_dot = B.startswith('.')
  579.     if initial_dot and A.endswith(B):
  580.         return True
  581.     
  582.     if not initial_dot and A == B:
  583.         return True
  584.     
  585.     return False
  586.  
  587. cut_port_re = re.compile(':\\d+$')
  588.  
  589. def request_host(request):
  590.     '''Return request-host, as defined by RFC 2965.
  591.  
  592.     Variation from RFC: returned value is lowercased, for convenient
  593.     comparison.
  594.  
  595.     '''
  596.     url = request.get_full_url()
  597.     host = urlparse.urlparse(url)[1]
  598.     if host == '':
  599.         host = request.get_header('Host', '')
  600.     
  601.     host = cut_port_re.sub('', host, 1)
  602.     return host.lower()
  603.  
  604.  
  605. def eff_request_host(request):
  606.     '''Return a tuple (request-host, effective request-host name).
  607.  
  608.     As defined by RFC 2965, except both are lowercased.
  609.  
  610.     '''
  611.     erhn = req_host = request_host(request)
  612.     if req_host.find('.') == -1 and not IPV4_RE.search(req_host):
  613.         erhn = req_host + '.local'
  614.     
  615.     return (req_host, erhn)
  616.  
  617.  
  618. def request_path(request):
  619.     '''request-URI, as defined by RFC 2965.'''
  620.     url = request.get_full_url()
  621.     (path, parameters, query, frag) = urlparse.urlparse(url)[2:]
  622.     if parameters:
  623.         path = '%s;%s' % (path, parameters)
  624.     
  625.     path = escape_path(path)
  626.     req_path = urlparse.urlunparse(('', '', path, '', query, frag))
  627.     if not req_path.startswith('/'):
  628.         req_path = '/' + req_path
  629.     
  630.     return req_path
  631.  
  632.  
  633. def request_port(request):
  634.     host = request.get_host()
  635.     i = host.find(':')
  636.     if i >= 0:
  637.         port = host[i + 1:]
  638.         
  639.         try:
  640.             int(port)
  641.         except ValueError:
  642.             _debug("nonnumeric port: '%s'", port)
  643.             return None
  644.         except:
  645.             None<EXCEPTION MATCH>ValueError
  646.         
  647.  
  648.     None<EXCEPTION MATCH>ValueError
  649.     port = DEFAULT_HTTP_PORT
  650.     return port
  651.  
  652. HTTP_PATH_SAFE = "%/;:@&=+$,!~*'()"
  653. ESCAPED_CHAR_RE = re.compile('%([0-9a-fA-F][0-9a-fA-F])')
  654.  
  655. def uppercase_escaped_char(match):
  656.     return '%%%s' % match.group(1).upper()
  657.  
  658.  
  659. def escape_path(path):
  660.     '''Escape any invalid characters in HTTP URL, and uppercase all escapes.'''
  661.     if isinstance(path, unicode):
  662.         path = path.encode('utf-8')
  663.     
  664.     path = urllib.quote(path, HTTP_PATH_SAFE)
  665.     path = ESCAPED_CHAR_RE.sub(uppercase_escaped_char, path)
  666.     return path
  667.  
  668.  
  669. def reach(h):
  670.     '''Return reach of host h, as defined by RFC 2965, section 1.
  671.  
  672.     The reach R of a host name H is defined as follows:
  673.  
  674.        *  If
  675.  
  676.           -  H is the host domain name of a host; and,
  677.  
  678.           -  H has the form A.B; and
  679.  
  680.           -  A has no embedded (that is, interior) dots; and
  681.  
  682.           -  B has at least one embedded dot, or B is the string "local".
  683.              then the reach of H is .B.
  684.  
  685.        *  Otherwise, the reach of H is H.
  686.  
  687.     >>> reach("www.acme.com")
  688.     \'.acme.com\'
  689.     >>> reach("acme.com")
  690.     \'acme.com\'
  691.     >>> reach("acme.local")
  692.     \'.local\'
  693.  
  694.     '''
  695.     i = h.find('.')
  696.     if i >= 0:
  697.         b = h[i + 1:]
  698.         i = b.find('.')
  699.         if is_HDN(h):
  700.             pass
  701.         None if i >= 0 or b == 'local' else b == 'local'
  702.     
  703.     return h
  704.  
  705.  
  706. def is_third_party(request):
  707.     '''
  708.  
  709.     RFC 2965, section 3.3.6:
  710.  
  711.         An unverifiable transaction is to a third-party host if its request-
  712.         host U does not domain-match the reach R of the request-host O in the
  713.         origin transaction.
  714.  
  715.     '''
  716.     req_host = request_host(request)
  717.     if not domain_match(req_host, reach(request.get_origin_req_host())):
  718.         return True
  719.     else:
  720.         return False
  721.  
  722.  
  723. class Cookie:
  724.     '''HTTP Cookie.
  725.  
  726.     This class represents both Netscape and RFC 2965 cookies.
  727.  
  728.     This is deliberately a very simple class.  It just holds attributes.  It\'s
  729.     possible to construct Cookie instances that don\'t comply with the cookie
  730.     standards.  CookieJar.make_cookies is the factory function for Cookie
  731.     objects -- it deals with cookie parsing, supplying defaults, and
  732.     normalising to the representation used in this class.  CookiePolicy is
  733.     responsible for checking them to see whether they should be accepted from
  734.     and returned to the server.
  735.  
  736.     Note that the port may be present in the headers, but unspecified ("Port"
  737.     rather than"Port=80", for example); if this is the case, port is None.
  738.  
  739.     '''
  740.     
  741.     def __init__(self, version, name, value, port, port_specified, domain, domain_specified, domain_initial_dot, path, path_specified, secure, expires, discard, comment, comment_url, rest, rfc2109 = False):
  742.         if version is not None:
  743.             version = int(version)
  744.         
  745.         if expires is not None:
  746.             expires = int(expires)
  747.         
  748.         if port is None and port_specified is True:
  749.             raise ValueError('if port is None, port_specified must be false')
  750.         
  751.         self.version = version
  752.         self.name = name
  753.         self.value = value
  754.         self.port = port
  755.         self.port_specified = port_specified
  756.         self.domain = domain.lower()
  757.         self.domain_specified = domain_specified
  758.         self.domain_initial_dot = domain_initial_dot
  759.         self.path = path
  760.         self.path_specified = path_specified
  761.         self.secure = secure
  762.         self.expires = expires
  763.         self.discard = discard
  764.         self.comment = comment
  765.         self.comment_url = comment_url
  766.         self.rfc2109 = rfc2109
  767.         self._rest = copy.copy(rest)
  768.  
  769.     
  770.     def has_nonstandard_attr(self, name):
  771.         return name in self._rest
  772.  
  773.     
  774.     def get_nonstandard_attr(self, name, default = None):
  775.         return self._rest.get(name, default)
  776.  
  777.     
  778.     def set_nonstandard_attr(self, name, value):
  779.         self._rest[name] = value
  780.  
  781.     
  782.     def is_expired(self, now = None):
  783.         if now is None:
  784.             now = time.time()
  785.         
  786.         if self.expires is not None and self.expires <= now:
  787.             return True
  788.         
  789.         return False
  790.  
  791.     
  792.     def __str__(self):
  793.         if self.port is None:
  794.             p = ''
  795.         else:
  796.             p = ':' + self.port
  797.         limit = self.domain + p + self.path
  798.         if self.value is not None:
  799.             namevalue = '%s=%s' % (self.name, self.value)
  800.         else:
  801.             namevalue = self.name
  802.         return '<Cookie %s for %s>' % (namevalue, limit)
  803.  
  804.     
  805.     def __repr__(self):
  806.         args = []
  807.         for name in ('version', 'name', 'value', 'port', 'port_specified', 'domain', 'domain_specified', 'domain_initial_dot', 'path', 'path_specified', 'secure', 'expires', 'discard', 'comment', 'comment_url'):
  808.             attr = getattr(self, name)
  809.             args.append('%s=%s' % (name, repr(attr)))
  810.         
  811.         args.append('rest=%s' % repr(self._rest))
  812.         args.append('rfc2109=%s' % repr(self.rfc2109))
  813.         return 'Cookie(%s)' % ', '.join(args)
  814.  
  815.  
  816.  
  817. class CookiePolicy:
  818.     '''Defines which cookies get accepted from and returned to server.
  819.  
  820.     May also modify cookies, though this is probably a bad idea.
  821.  
  822.     The subclass DefaultCookiePolicy defines the standard rules for Netscape
  823.     and RFC 2965 cookies -- override that if you want a customised policy.
  824.  
  825.     '''
  826.     
  827.     def set_ok(self, cookie, request):
  828.         '''Return true if (and only if) cookie should be accepted from server.
  829.  
  830.         Currently, pre-expired cookies never get this far -- the CookieJar
  831.         class deletes such cookies itself.
  832.  
  833.         '''
  834.         raise NotImplementedError()
  835.  
  836.     
  837.     def return_ok(self, cookie, request):
  838.         '''Return true if (and only if) cookie should be returned to server.'''
  839.         raise NotImplementedError()
  840.  
  841.     
  842.     def domain_return_ok(self, domain, request):
  843.         '''Return false if cookies should not be returned, given cookie domain.
  844.         '''
  845.         return True
  846.  
  847.     
  848.     def path_return_ok(self, path, request):
  849.         '''Return false if cookies should not be returned, given cookie path.
  850.         '''
  851.         return True
  852.  
  853.  
  854.  
  855. class DefaultCookiePolicy(CookiePolicy):
  856.     '''Implements the standard rules for accepting and returning cookies.'''
  857.     DomainStrictNoDots = 1
  858.     DomainStrictNonDomain = 2
  859.     DomainRFC2965Match = 4
  860.     DomainLiberal = 0
  861.     DomainStrict = DomainStrictNoDots | DomainStrictNonDomain
  862.     
  863.     def __init__(self, blocked_domains = None, allowed_domains = None, netscape = True, rfc2965 = False, rfc2109_as_netscape = None, hide_cookie2 = False, strict_domain = False, strict_rfc2965_unverifiable = True, strict_ns_unverifiable = False, strict_ns_domain = DomainLiberal, strict_ns_set_initial_dollar = False, strict_ns_set_path = False):
  864.         '''Constructor arguments should be passed as keyword arguments only.'''
  865.         self.netscape = netscape
  866.         self.rfc2965 = rfc2965
  867.         self.rfc2109_as_netscape = rfc2109_as_netscape
  868.         self.hide_cookie2 = hide_cookie2
  869.         self.strict_domain = strict_domain
  870.         self.strict_rfc2965_unverifiable = strict_rfc2965_unverifiable
  871.         self.strict_ns_unverifiable = strict_ns_unverifiable
  872.         self.strict_ns_domain = strict_ns_domain
  873.         self.strict_ns_set_initial_dollar = strict_ns_set_initial_dollar
  874.         self.strict_ns_set_path = strict_ns_set_path
  875.         if blocked_domains is not None:
  876.             self._blocked_domains = tuple(blocked_domains)
  877.         else:
  878.             self._blocked_domains = ()
  879.         if allowed_domains is not None:
  880.             allowed_domains = tuple(allowed_domains)
  881.         
  882.         self._allowed_domains = allowed_domains
  883.  
  884.     
  885.     def blocked_domains(self):
  886.         '''Return the sequence of blocked domains (as a tuple).'''
  887.         return self._blocked_domains
  888.  
  889.     
  890.     def set_blocked_domains(self, blocked_domains):
  891.         '''Set the sequence of blocked domains.'''
  892.         self._blocked_domains = tuple(blocked_domains)
  893.  
  894.     
  895.     def is_blocked(self, domain):
  896.         for blocked_domain in self._blocked_domains:
  897.             if user_domain_match(domain, blocked_domain):
  898.                 return True
  899.                 continue
  900.         
  901.         return False
  902.  
  903.     
  904.     def allowed_domains(self):
  905.         '''Return None, or the sequence of allowed domains (as a tuple).'''
  906.         return self._allowed_domains
  907.  
  908.     
  909.     def set_allowed_domains(self, allowed_domains):
  910.         '''Set the sequence of allowed domains, or None.'''
  911.         if allowed_domains is not None:
  912.             allowed_domains = tuple(allowed_domains)
  913.         
  914.         self._allowed_domains = allowed_domains
  915.  
  916.     
  917.     def is_not_allowed(self, domain):
  918.         if self._allowed_domains is None:
  919.             return False
  920.         
  921.         for allowed_domain in self._allowed_domains:
  922.             if user_domain_match(domain, allowed_domain):
  923.                 return False
  924.                 continue
  925.         
  926.         return True
  927.  
  928.     
  929.     def set_ok(self, cookie, request):
  930.         '''
  931.         If you override .set_ok(), be sure to call this method.  If it returns
  932.         false, so should your subclass (assuming your subclass wants to be more
  933.         strict about which cookies to accept).
  934.  
  935.         '''
  936.         _debug(' - checking cookie %s=%s', cookie.name, cookie.value)
  937.         if not cookie.name is not None:
  938.             raise AssertionError
  939.         for n in ('version', 'verifiability', 'name', 'path', 'domain', 'port'):
  940.             fn_name = 'set_ok_' + n
  941.             fn = getattr(self, fn_name)
  942.             if not fn(cookie, request):
  943.                 return False
  944.                 continue
  945.         
  946.         return True
  947.  
  948.     
  949.     def set_ok_version(self, cookie, request):
  950.         if cookie.version is None:
  951.             _debug('   Set-Cookie2 without version attribute (%s=%s)', cookie.name, cookie.value)
  952.             return False
  953.         
  954.         if cookie.version > 0 and not (self.rfc2965):
  955.             _debug('   RFC 2965 cookies are switched off')
  956.             return False
  957.         elif cookie.version == 0 and not (self.netscape):
  958.             _debug('   Netscape cookies are switched off')
  959.             return False
  960.         
  961.         return True
  962.  
  963.     
  964.     def set_ok_verifiability(self, cookie, request):
  965.         if request.is_unverifiable() and is_third_party(request):
  966.             if cookie.version > 0 and self.strict_rfc2965_unverifiable:
  967.                 _debug('   third-party RFC 2965 cookie during unverifiable transaction')
  968.                 return False
  969.             elif cookie.version == 0 and self.strict_ns_unverifiable:
  970.                 _debug('   third-party Netscape cookie during unverifiable transaction')
  971.                 return False
  972.             
  973.         
  974.         return True
  975.  
  976.     
  977.     def set_ok_name(self, cookie, request):
  978.         if cookie.version == 0 and self.strict_ns_set_initial_dollar and cookie.name.startswith('$'):
  979.             _debug("   illegal name (starts with '$'): '%s'", cookie.name)
  980.             return False
  981.         
  982.         return True
  983.  
  984.     
  985.     def set_ok_path(self, cookie, request):
  986.         if cookie.path_specified:
  987.             req_path = request_path(request)
  988.             if (cookie.version > 0 or cookie.version == 0 or self.strict_ns_set_path) and not req_path.startswith(cookie.path):
  989.                 _debug('   path attribute %s is not a prefix of request path %s', cookie.path, req_path)
  990.                 return False
  991.             
  992.         
  993.         return True
  994.  
  995.     
  996.     def set_ok_domain(self, cookie, request):
  997.         if self.is_blocked(cookie.domain):
  998.             _debug('   domain %s is in user block-list', cookie.domain)
  999.             return False
  1000.         
  1001.         if self.is_not_allowed(cookie.domain):
  1002.             _debug('   domain %s is not in user allow-list', cookie.domain)
  1003.             return False
  1004.         
  1005.         if cookie.domain_specified:
  1006.             (req_host, erhn) = eff_request_host(request)
  1007.             domain = cookie.domain
  1008.             if self.strict_domain and domain.count('.') >= 2:
  1009.                 i = domain.rfind('.')
  1010.                 j = domain.rfind('.', 0, i)
  1011.                 if j == 0:
  1012.                     tld = domain[i + 1:]
  1013.                     sld = domain[j + 1:i]
  1014.                     if sld.lower() in ('co', 'ac', 'com', 'edu', 'org', 'net', 'gov', 'mil', 'int', 'aero', 'biz', 'cat', 'coop', 'info', 'jobs', 'mobi', 'museum', 'name', 'pro', 'travel', 'eu') and len(tld) == 2:
  1015.                         _debug('   country-code second level domain %s', domain)
  1016.                         return False
  1017.                     
  1018.                 
  1019.             
  1020.             if domain.startswith('.'):
  1021.                 undotted_domain = domain[1:]
  1022.             else:
  1023.                 undotted_domain = domain
  1024.             embedded_dots = undotted_domain.find('.') >= 0
  1025.             if not embedded_dots and domain != '.local':
  1026.                 _debug('   non-local domain %s contains no embedded dot', domain)
  1027.                 return False
  1028.             
  1029.             if cookie.version == 0:
  1030.                 if not erhn.endswith(domain) and not erhn.startswith('.') and not ('.' + erhn).endswith(domain):
  1031.                     _debug('   effective request-host %s (even with added initial dot) does not end end with %s', erhn, domain)
  1032.                     return False
  1033.                 
  1034.             
  1035.             if cookie.version > 0 or self.strict_ns_domain & self.DomainRFC2965Match:
  1036.                 if not domain_match(erhn, domain):
  1037.                     _debug('   effective request-host %s does not domain-match %s', erhn, domain)
  1038.                     return False
  1039.                 
  1040.             
  1041.             if cookie.version > 0 or self.strict_ns_domain & self.DomainStrictNoDots:
  1042.                 host_prefix = req_host[:-len(domain)]
  1043.                 if host_prefix.find('.') >= 0 and not IPV4_RE.search(req_host):
  1044.                     _debug('   host prefix %s for domain %s contains a dot', host_prefix, domain)
  1045.                     return False
  1046.                 
  1047.             
  1048.         
  1049.         return True
  1050.  
  1051.     
  1052.     def set_ok_port(self, cookie, request):
  1053.         if cookie.port_specified:
  1054.             req_port = request_port(request)
  1055.             if req_port is None:
  1056.                 req_port = '80'
  1057.             else:
  1058.                 req_port = str(req_port)
  1059.             for p in cookie.port.split(','):
  1060.                 
  1061.                 try:
  1062.                     int(p)
  1063.                 except ValueError:
  1064.                     _debug('   bad port %s (not numeric)', p)
  1065.                     return False
  1066.  
  1067.                 if p == req_port:
  1068.                     break
  1069.                     continue
  1070.             else:
  1071.                 return False
  1072.         
  1073.         return True
  1074.  
  1075.     
  1076.     def return_ok(self, cookie, request):
  1077.         '''
  1078.         If you override .return_ok(), be sure to call this method.  If it
  1079.         returns false, so should your subclass (assuming your subclass wants to
  1080.         be more strict about which cookies to return).
  1081.  
  1082.         '''
  1083.         _debug(' - checking cookie %s=%s', cookie.name, cookie.value)
  1084.         for n in ('version', 'verifiability', 'secure', 'expires', 'port', 'domain'):
  1085.             fn_name = 'return_ok_' + n
  1086.             fn = getattr(self, fn_name)
  1087.             if not fn(cookie, request):
  1088.                 return False
  1089.                 continue
  1090.         
  1091.         return True
  1092.  
  1093.     
  1094.     def return_ok_version(self, cookie, request):
  1095.         if cookie.version > 0 and not (self.rfc2965):
  1096.             _debug('   RFC 2965 cookies are switched off')
  1097.             return False
  1098.         elif cookie.version == 0 and not (self.netscape):
  1099.             _debug('   Netscape cookies are switched off')
  1100.             return False
  1101.         
  1102.         return True
  1103.  
  1104.     
  1105.     def return_ok_verifiability(self, cookie, request):
  1106.         if request.is_unverifiable() and is_third_party(request):
  1107.             if cookie.version > 0 and self.strict_rfc2965_unverifiable:
  1108.                 _debug('   third-party RFC 2965 cookie during unverifiable transaction')
  1109.                 return False
  1110.             elif cookie.version == 0 and self.strict_ns_unverifiable:
  1111.                 _debug('   third-party Netscape cookie during unverifiable transaction')
  1112.                 return False
  1113.             
  1114.         
  1115.         return True
  1116.  
  1117.     
  1118.     def return_ok_secure(self, cookie, request):
  1119.         if cookie.secure and request.get_type() != 'https':
  1120.             _debug('   secure cookie with non-secure request')
  1121.             return False
  1122.         
  1123.         return True
  1124.  
  1125.     
  1126.     def return_ok_expires(self, cookie, request):
  1127.         if cookie.is_expired(self._now):
  1128.             _debug('   cookie expired')
  1129.             return False
  1130.         
  1131.         return True
  1132.  
  1133.     
  1134.     def return_ok_port(self, cookie, request):
  1135.         if cookie.port:
  1136.             req_port = request_port(request)
  1137.             if req_port is None:
  1138.                 req_port = '80'
  1139.             
  1140.             for p in cookie.port.split(','):
  1141.                 if p == req_port:
  1142.                     break
  1143.                     continue
  1144.             else:
  1145.                 return False
  1146.         
  1147.         return True
  1148.  
  1149.     
  1150.     def return_ok_domain(self, cookie, request):
  1151.         (req_host, erhn) = eff_request_host(request)
  1152.         domain = cookie.domain
  1153.         if cookie.version == 0 and self.strict_ns_domain & self.DomainStrictNonDomain and not (cookie.domain_specified) and domain != erhn:
  1154.             _debug('   cookie with unspecified domain does not string-compare equal to request domain')
  1155.             return False
  1156.         
  1157.         if cookie.version > 0 and not domain_match(erhn, domain):
  1158.             _debug('   effective request-host name %s does not domain-match RFC 2965 cookie domain %s', erhn, domain)
  1159.             return False
  1160.         
  1161.         if cookie.version == 0 and not ('.' + erhn).endswith(domain):
  1162.             _debug('   request-host %s does not match Netscape cookie domain %s', req_host, domain)
  1163.             return False
  1164.         
  1165.         return True
  1166.  
  1167.     
  1168.     def domain_return_ok(self, domain, request):
  1169.         (req_host, erhn) = eff_request_host(request)
  1170.         if not req_host.startswith('.'):
  1171.             req_host = '.' + req_host
  1172.         
  1173.         if not erhn.startswith('.'):
  1174.             erhn = '.' + erhn
  1175.         
  1176.         if not req_host.endswith(domain) or erhn.endswith(domain):
  1177.             return False
  1178.         
  1179.         if self.is_blocked(domain):
  1180.             _debug('   domain %s is in user block-list', domain)
  1181.             return False
  1182.         
  1183.         if self.is_not_allowed(domain):
  1184.             _debug('   domain %s is not in user allow-list', domain)
  1185.             return False
  1186.         
  1187.         return True
  1188.  
  1189.     
  1190.     def path_return_ok(self, path, request):
  1191.         _debug('- checking cookie path=%s', path)
  1192.         req_path = request_path(request)
  1193.         if not req_path.startswith(path):
  1194.             _debug('  %s does not path-match %s', req_path, path)
  1195.             return False
  1196.         
  1197.         return True
  1198.  
  1199.  
  1200.  
  1201. def vals_sorted_by_key(adict):
  1202.     keys = adict.keys()
  1203.     keys.sort()
  1204.     return map(adict.get, keys)
  1205.  
  1206.  
  1207. def deepvalues(mapping):
  1208.     '''Iterates over nested mapping, depth-first, in sorted order by key.'''
  1209.     values = vals_sorted_by_key(mapping)
  1210.     for obj in values:
  1211.         mapping = False
  1212.         
  1213.         try:
  1214.             obj.items
  1215.         except AttributeError:
  1216.             pass
  1217.  
  1218.         mapping = True
  1219.         for subobj in deepvalues(obj):
  1220.             yield subobj
  1221.         
  1222.         if not mapping:
  1223.             yield obj
  1224.             continue
  1225.     
  1226.  
  1227.  
  1228. class Absent:
  1229.     pass
  1230.  
  1231.  
  1232. class CookieJar:
  1233.     '''Collection of HTTP cookies.
  1234.  
  1235.     You may not need to know about this class: try
  1236.     urllib2.build_opener(HTTPCookieProcessor).open(url).
  1237.  
  1238.     '''
  1239.     non_word_re = re.compile('\\W')
  1240.     quote_re = re.compile('([\\"\\\\])')
  1241.     strict_domain_re = re.compile('\\.?[^.]*')
  1242.     domain_re = re.compile('[^.]*')
  1243.     dots_re = re.compile('^\\.+')
  1244.     magic_re = '^\\#LWP-Cookies-(\\d+\\.\\d+)'
  1245.     
  1246.     def __init__(self, policy = None):
  1247.         if policy is None:
  1248.             policy = DefaultCookiePolicy()
  1249.         
  1250.         self._policy = policy
  1251.         self._cookies_lock = _threading.RLock()
  1252.         self._cookies = { }
  1253.  
  1254.     
  1255.     def set_policy(self, policy):
  1256.         self._policy = policy
  1257.  
  1258.     
  1259.     def _cookies_for_domain(self, domain, request):
  1260.         cookies = []
  1261.         if not self._policy.domain_return_ok(domain, request):
  1262.             return []
  1263.         
  1264.         _debug('Checking %s for cookies to return', domain)
  1265.         cookies_by_path = self._cookies[domain]
  1266.         for path in cookies_by_path.keys():
  1267.             if not self._policy.path_return_ok(path, request):
  1268.                 continue
  1269.             
  1270.             cookies_by_name = cookies_by_path[path]
  1271.             for cookie in cookies_by_name.values():
  1272.                 if not self._policy.return_ok(cookie, request):
  1273.                     _debug('   not returning cookie')
  1274.                     continue
  1275.                 
  1276.                 _debug("   it's a match")
  1277.                 cookies.append(cookie)
  1278.             
  1279.         
  1280.         return cookies
  1281.  
  1282.     
  1283.     def _cookies_for_request(self, request):
  1284.         '''Return a list of cookies to be returned to server.'''
  1285.         cookies = []
  1286.         for domain in self._cookies.keys():
  1287.             cookies.extend(self._cookies_for_domain(domain, request))
  1288.         
  1289.         return cookies
  1290.  
  1291.     
  1292.     def _cookie_attrs(self, cookies):
  1293.         '''Return a list of cookie-attributes to be returned to server.
  1294.  
  1295.         like [\'foo="bar"; $Path="/"\', ...]
  1296.  
  1297.         The $Version attribute is also added when appropriate (currently only
  1298.         once per request).
  1299.  
  1300.         '''
  1301.         
  1302.         def decreasing_size(a, b):
  1303.             return cmp(len(b.path), len(a.path))
  1304.  
  1305.         cookies.sort(decreasing_size)
  1306.         version_set = False
  1307.         attrs = []
  1308.         for cookie in cookies:
  1309.             version = cookie.version
  1310.             if not version_set:
  1311.                 version_set = True
  1312.                 if version > 0:
  1313.                     attrs.append('$Version=%s' % version)
  1314.                 
  1315.             
  1316.             if cookie.value is not None and self.non_word_re.search(cookie.value) and version > 0:
  1317.                 value = self.quote_re.sub('\\\\\\1', cookie.value)
  1318.             else:
  1319.                 value = cookie.value
  1320.             if cookie.value is None:
  1321.                 attrs.append(cookie.name)
  1322.             else:
  1323.                 attrs.append('%s=%s' % (cookie.name, value))
  1324.             if version > 0:
  1325.                 if cookie.path_specified:
  1326.                     attrs.append('$Path="%s"' % cookie.path)
  1327.                 
  1328.                 if cookie.domain.startswith('.'):
  1329.                     domain = cookie.domain
  1330.                     if not (cookie.domain_initial_dot) and domain.startswith('.'):
  1331.                         domain = domain[1:]
  1332.                     
  1333.                     attrs.append('$Domain="%s"' % domain)
  1334.                 
  1335.                 if cookie.port is not None:
  1336.                     p = '$Port'
  1337.                     if cookie.port_specified:
  1338.                         p = p + '="%s"' % cookie.port
  1339.                     
  1340.                     attrs.append(p)
  1341.                 
  1342.             cookie.port is not None
  1343.         
  1344.         return attrs
  1345.  
  1346.     
  1347.     def add_cookie_header(self, request):
  1348.         '''Add correct Cookie: header to request (urllib2.Request object).
  1349.  
  1350.         The Cookie2 header is also added unless policy.hide_cookie2 is true.
  1351.  
  1352.         '''
  1353.         _debug('add_cookie_header')
  1354.         self._cookies_lock.acquire()
  1355.         self._policy._now = self._now = int(time.time())
  1356.         cookies = self._cookies_for_request(request)
  1357.         attrs = self._cookie_attrs(cookies)
  1358.         if attrs:
  1359.             if not request.has_header('Cookie'):
  1360.                 request.add_unredirected_header('Cookie', '; '.join(attrs))
  1361.             
  1362.         
  1363.         if self._policy.rfc2965 and not (self._policy.hide_cookie2) and not request.has_header('Cookie2'):
  1364.             for cookie in cookies:
  1365.                 if cookie.version != 1:
  1366.                     request.add_unredirected_header('Cookie2', '$Version="1"')
  1367.                     break
  1368.                     continue
  1369.             
  1370.         
  1371.         self._cookies_lock.release()
  1372.         self.clear_expired_cookies()
  1373.  
  1374.     
  1375.     def _normalized_cookie_tuples(self, attrs_set):
  1376.         '''Return list of tuples containing normalised cookie information.
  1377.  
  1378.         attrs_set is the list of lists of key,value pairs extracted from
  1379.         the Set-Cookie or Set-Cookie2 headers.
  1380.  
  1381.         Tuples are name, value, standard, rest, where name and value are the
  1382.         cookie name and value, standard is a dictionary containing the standard
  1383.         cookie-attributes (discard, secure, version, expires or max-age,
  1384.         domain, path and port) and rest is a dictionary containing the rest of
  1385.         the cookie-attributes.
  1386.  
  1387.         '''
  1388.         cookie_tuples = []
  1389.         boolean_attrs = ('discard', 'secure')
  1390.         value_attrs = ('version', 'expires', 'max-age', 'domain', 'path', 'port', 'comment', 'commenturl')
  1391.         for cookie_attrs in attrs_set:
  1392.             (name, value) = cookie_attrs[0]
  1393.             max_age_set = False
  1394.             bad_cookie = False
  1395.             standard = { }
  1396.             rest = { }
  1397.             for k, v in cookie_attrs[1:]:
  1398.                 lc = k.lower()
  1399.                 if lc in value_attrs or lc in boolean_attrs:
  1400.                     k = lc
  1401.                 
  1402.                 if k in boolean_attrs and v is None:
  1403.                     v = True
  1404.                 
  1405.                 if k in standard:
  1406.                     continue
  1407.                 
  1408.                 if k == 'domain':
  1409.                     if v is None:
  1410.                         _debug('   missing value for domain attribute')
  1411.                         bad_cookie = True
  1412.                         break
  1413.                     
  1414.                     v = v.lower()
  1415.                 
  1416.                 if k == 'expires':
  1417.                     if max_age_set:
  1418.                         continue
  1419.                     
  1420.                     if v is None:
  1421.                         _debug('   missing or invalid value for expires attribute: treating as session cookie')
  1422.                         continue
  1423.                     
  1424.                 
  1425.                 if k == 'max-age':
  1426.                     max_age_set = True
  1427.                     
  1428.                     try:
  1429.                         v = int(v)
  1430.                     except ValueError:
  1431.                         _debug('   missing or invalid (non-numeric) value for max-age attribute')
  1432.                         bad_cookie = True
  1433.                         break
  1434.  
  1435.                     k = 'expires'
  1436.                     v = self._now + v
  1437.                 
  1438.                 if k in value_attrs or k in boolean_attrs:
  1439.                     if v is None and k not in ('port', 'comment', 'commenturl'):
  1440.                         _debug('   missing value for %s attribute' % k)
  1441.                         bad_cookie = True
  1442.                         break
  1443.                     
  1444.                     standard[k] = v
  1445.                     continue
  1446.                 rest[k] = v
  1447.             
  1448.             if bad_cookie:
  1449.                 continue
  1450.             
  1451.             cookie_tuples.append((name, value, standard, rest))
  1452.         
  1453.         return cookie_tuples
  1454.  
  1455.     
  1456.     def _cookie_from_cookie_tuple(self, tup, request):
  1457.         (name, value, standard, rest) = tup
  1458.         domain = standard.get('domain', Absent)
  1459.         path = standard.get('path', Absent)
  1460.         port = standard.get('port', Absent)
  1461.         expires = standard.get('expires', Absent)
  1462.         version = standard.get('version', None)
  1463.         if version is not None:
  1464.             version = int(version)
  1465.         
  1466.         secure = standard.get('secure', False)
  1467.         discard = standard.get('discard', False)
  1468.         comment = standard.get('comment', None)
  1469.         comment_url = standard.get('commenturl', None)
  1470.         if path is not Absent and path != '':
  1471.             path_specified = True
  1472.             path = escape_path(path)
  1473.         else:
  1474.             path_specified = False
  1475.             path = request_path(request)
  1476.             i = path.rfind('/')
  1477.             if i != -1:
  1478.                 if version == 0:
  1479.                     path = path[:i]
  1480.                 else:
  1481.                     path = path[:i + 1]
  1482.             
  1483.             if len(path) == 0:
  1484.                 path = '/'
  1485.             
  1486.         domain_specified = domain is not Absent
  1487.         domain_initial_dot = False
  1488.         if domain_specified:
  1489.             domain_initial_dot = bool(domain.startswith('.'))
  1490.         
  1491.         if domain is Absent:
  1492.             (req_host, erhn) = eff_request_host(request)
  1493.             domain = erhn
  1494.         elif not domain.startswith('.'):
  1495.             domain = '.' + domain
  1496.         
  1497.         port_specified = False
  1498.         if port is not Absent:
  1499.             if port is None:
  1500.                 port = request_port(request)
  1501.             else:
  1502.                 port_specified = True
  1503.                 port = re.sub('\\s+', '', port)
  1504.         else:
  1505.             port = None
  1506.         if expires is Absent:
  1507.             expires = None
  1508.             discard = True
  1509.         elif expires <= self._now:
  1510.             
  1511.             try:
  1512.                 self.clear(domain, path, name)
  1513.             except KeyError:
  1514.                 pass
  1515.  
  1516.             _debug("Expiring cookie, domain='%s', path='%s', name='%s'", domain, path, name)
  1517.             return None
  1518.         
  1519.         return Cookie(version, name, value, port, port_specified, domain, domain_specified, domain_initial_dot, path, path_specified, secure, expires, discard, comment, comment_url, rest)
  1520.  
  1521.     
  1522.     def _cookies_from_attrs_set(self, attrs_set, request):
  1523.         cookie_tuples = self._normalized_cookie_tuples(attrs_set)
  1524.         cookies = []
  1525.         for tup in cookie_tuples:
  1526.             cookie = self._cookie_from_cookie_tuple(tup, request)
  1527.             if cookie:
  1528.                 cookies.append(cookie)
  1529.                 continue
  1530.         
  1531.         return cookies
  1532.  
  1533.     
  1534.     def _process_rfc2109_cookies(self, cookies):
  1535.         rfc2109_as_ns = getattr(self._policy, 'rfc2109_as_netscape', None)
  1536.         if rfc2109_as_ns is None:
  1537.             rfc2109_as_ns = not (self._policy.rfc2965)
  1538.         
  1539.         for cookie in cookies:
  1540.             if cookie.version == 1:
  1541.                 cookie.rfc2109 = True
  1542.                 if rfc2109_as_ns:
  1543.                     cookie.version = 0
  1544.                 
  1545.             rfc2109_as_ns
  1546.         
  1547.  
  1548.     
  1549.     def make_cookies(self, response, request):
  1550.         '''Return sequence of Cookie objects extracted from response object.'''
  1551.         headers = response.info()
  1552.         rfc2965_hdrs = headers.getheaders('Set-Cookie2')
  1553.         ns_hdrs = headers.getheaders('Set-Cookie')
  1554.         rfc2965 = self._policy.rfc2965
  1555.         netscape = self._policy.netscape
  1556.         if not not rfc2965_hdrs or not ns_hdrs:
  1557.             if not not ns_hdrs or not rfc2965:
  1558.                 if (not rfc2965_hdrs or not netscape or not netscape) and not rfc2965:
  1559.                     return []
  1560.                 
  1561.         
  1562.         try:
  1563.             cookies = self._cookies_from_attrs_set(split_header_words(rfc2965_hdrs), request)
  1564.         except Exception:
  1565.             _warn_unhandled_exception()
  1566.             cookies = []
  1567.  
  1568.         if ns_hdrs and netscape:
  1569.             
  1570.             try:
  1571.                 ns_cookies = self._cookies_from_attrs_set(parse_ns_headers(ns_hdrs), request)
  1572.             except Exception:
  1573.                 _warn_unhandled_exception()
  1574.                 ns_cookies = []
  1575.  
  1576.             self._process_rfc2109_cookies(ns_cookies)
  1577.             if rfc2965:
  1578.                 lookup = { }
  1579.                 for cookie in cookies:
  1580.                     lookup[(cookie.domain, cookie.path, cookie.name)] = None
  1581.                 
  1582.                 
  1583.                 def no_matching_rfc2965(ns_cookie, lookup = lookup):
  1584.                     key = (ns_cookie.domain, ns_cookie.path, ns_cookie.name)
  1585.                     return key not in lookup
  1586.  
  1587.                 ns_cookies = filter(no_matching_rfc2965, ns_cookies)
  1588.             
  1589.             if ns_cookies:
  1590.                 cookies.extend(ns_cookies)
  1591.             
  1592.         
  1593.         return cookies
  1594.  
  1595.     
  1596.     def set_cookie_if_ok(self, cookie, request):
  1597.         """Set a cookie if policy says it's OK to do so."""
  1598.         self._cookies_lock.acquire()
  1599.         self._policy._now = self._now = int(time.time())
  1600.         if self._policy.set_ok(cookie, request):
  1601.             self.set_cookie(cookie)
  1602.         
  1603.         self._cookies_lock.release()
  1604.  
  1605.     
  1606.     def set_cookie(self, cookie):
  1607.         '''Set a cookie, without checking whether or not it should be set.'''
  1608.         c = self._cookies
  1609.         self._cookies_lock.acquire()
  1610.         
  1611.         try:
  1612.             if cookie.domain not in c:
  1613.                 c[cookie.domain] = { }
  1614.             
  1615.             c2 = c[cookie.domain]
  1616.             if cookie.path not in c2:
  1617.                 c2[cookie.path] = { }
  1618.             
  1619.             c3 = c2[cookie.path]
  1620.             c3[cookie.name] = cookie
  1621.         finally:
  1622.             self._cookies_lock.release()
  1623.  
  1624.  
  1625.     
  1626.     def extract_cookies(self, response, request):
  1627.         '''Extract cookies from response, where allowable given the request.'''
  1628.         _debug('extract_cookies: %s', response.info())
  1629.         self._cookies_lock.acquire()
  1630.         self._policy._now = self._now = int(time.time())
  1631.         for cookie in self.make_cookies(response, request):
  1632.             if self._policy.set_ok(cookie, request):
  1633.                 _debug(' setting cookie: %s', cookie)
  1634.                 self.set_cookie(cookie)
  1635.                 continue
  1636.         
  1637.         self._cookies_lock.release()
  1638.  
  1639.     
  1640.     def clear(self, domain = None, path = None, name = None):
  1641.         '''Clear some cookies.
  1642.  
  1643.         Invoking this method without arguments will clear all cookies.  If
  1644.         given a single argument, only cookies belonging to that domain will be
  1645.         removed.  If given two arguments, cookies belonging to the specified
  1646.         path within that domain are removed.  If given three arguments, then
  1647.         the cookie with the specified name, path and domain is removed.
  1648.  
  1649.         Raises KeyError if no matching cookie exists.
  1650.  
  1651.         '''
  1652.         if name is not None:
  1653.             if domain is None or path is None:
  1654.                 raise ValueError('domain and path must be given to remove a cookie by name')
  1655.             
  1656.             del self._cookies[domain][path][name]
  1657.         elif path is not None:
  1658.             if domain is None:
  1659.                 raise ValueError('domain must be given to remove cookies by path')
  1660.             
  1661.             del self._cookies[domain][path]
  1662.         elif domain is not None:
  1663.             del self._cookies[domain]
  1664.         else:
  1665.             self._cookies = { }
  1666.  
  1667.     
  1668.     def clear_session_cookies(self):
  1669.         """Discard all session cookies.
  1670.  
  1671.         Note that the .save() method won't save session cookies anyway, unless
  1672.         you ask otherwise by passing a true ignore_discard argument.
  1673.  
  1674.         """
  1675.         self._cookies_lock.acquire()
  1676.         for cookie in self:
  1677.             if cookie.discard:
  1678.                 self.clear(cookie.domain, cookie.path, cookie.name)
  1679.                 continue
  1680.         
  1681.         self._cookies_lock.release()
  1682.  
  1683.     
  1684.     def clear_expired_cookies(self):
  1685.         """Discard all expired cookies.
  1686.  
  1687.         You probably don't need to call this method: expired cookies are never
  1688.         sent back to the server (provided you're using DefaultCookiePolicy),
  1689.         this method is called by CookieJar itself every so often, and the
  1690.         .save() method won't save expired cookies anyway (unless you ask
  1691.         otherwise by passing a true ignore_expires argument).
  1692.  
  1693.         """
  1694.         self._cookies_lock.acquire()
  1695.         now = time.time()
  1696.         for cookie in self:
  1697.             if cookie.is_expired(now):
  1698.                 self.clear(cookie.domain, cookie.path, cookie.name)
  1699.                 continue
  1700.         
  1701.         self._cookies_lock.release()
  1702.  
  1703.     
  1704.     def __iter__(self):
  1705.         return deepvalues(self._cookies)
  1706.  
  1707.     
  1708.     def __len__(self):
  1709.         '''Return number of contained cookies.'''
  1710.         i = 0
  1711.         for cookie in self:
  1712.             i = i + 1
  1713.         
  1714.         return i
  1715.  
  1716.     
  1717.     def __repr__(self):
  1718.         r = []
  1719.         for cookie in self:
  1720.             r.append(repr(cookie))
  1721.         
  1722.         return '<%s[%s]>' % (self.__class__, ', '.join(r))
  1723.  
  1724.     
  1725.     def __str__(self):
  1726.         r = []
  1727.         for cookie in self:
  1728.             r.append(str(cookie))
  1729.         
  1730.         return '<%s[%s]>' % (self.__class__, ', '.join(r))
  1731.  
  1732.  
  1733.  
  1734. class LoadError(IOError):
  1735.     pass
  1736.  
  1737.  
  1738. class FileCookieJar(CookieJar):
  1739.     '''CookieJar that can be loaded from and saved to a file.'''
  1740.     
  1741.     def __init__(self, filename = None, delayload = False, policy = None):
  1742.         '''
  1743.         Cookies are NOT loaded from the named file until either the .load() or
  1744.         .revert() method is called.
  1745.  
  1746.         '''
  1747.         CookieJar.__init__(self, policy)
  1748.         if filename is not None:
  1749.             
  1750.             try:
  1751.                 filename + ''
  1752.             raise ValueError('filename must be string-like')
  1753.  
  1754.         
  1755.         self.filename = filename
  1756.         self.delayload = bool(delayload)
  1757.  
  1758.     
  1759.     def save(self, filename = None, ignore_discard = False, ignore_expires = False):
  1760.         '''Save cookies to a file.'''
  1761.         raise NotImplementedError()
  1762.  
  1763.     
  1764.     def load(self, filename = None, ignore_discard = False, ignore_expires = False):
  1765.         '''Load cookies from a file.'''
  1766.         if filename is None:
  1767.             if self.filename is not None:
  1768.                 filename = self.filename
  1769.             else:
  1770.                 raise ValueError(MISSING_FILENAME_TEXT)
  1771.         
  1772.         f = open(filename)
  1773.         
  1774.         try:
  1775.             self._really_load(f, filename, ignore_discard, ignore_expires)
  1776.         finally:
  1777.             f.close()
  1778.  
  1779.  
  1780.     
  1781.     def revert(self, filename = None, ignore_discard = False, ignore_expires = False):
  1782.         """Clear all cookies and reload cookies from a saved file.
  1783.  
  1784.         Raises LoadError (or IOError) if reversion is not successful; the
  1785.         object's state will not be altered if this happens.
  1786.  
  1787.         """
  1788.         if filename is None:
  1789.             if self.filename is not None:
  1790.                 filename = self.filename
  1791.             else:
  1792.                 raise ValueError(MISSING_FILENAME_TEXT)
  1793.         
  1794.         self._cookies_lock.acquire()
  1795.         old_state = copy.deepcopy(self._cookies)
  1796.         self._cookies = { }
  1797.         
  1798.         try:
  1799.             self.load(filename, ignore_discard, ignore_expires)
  1800.         except (LoadError, IOError):
  1801.             self._cookies = old_state
  1802.             raise 
  1803.  
  1804.         self._cookies_lock.release()
  1805.  
  1806.  
  1807. from _LWPCookieJar import LWPCookieJar, lwp_cookie_str
  1808. from _MozillaCookieJar import MozillaCookieJar
  1809.